<html>
<head><meta charset="utf-8"><title>rustdoc &quot;forgets&quot; two lines of the doc comment?? · general · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/index.html">general</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/rustdoc.20.22forgets.22.20two.20lines.20of.20the.20doc.20comment.3F.3F.html">rustdoc &quot;forgets&quot; two lines of the doc comment??</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="171367309"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/rustdoc%20%22forgets%22%20two%20lines%20of%20the%20doc%20comment%3F%3F/near/171367309" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> RalfJ <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/rustdoc.20.22forgets.22.20two.20lines.20of.20the.20doc.20comment.3F.3F.html#171367309">(Jul 21 2019 at 10:45)</a>:</h4>
<p>Compare <a href="https://github.com/rust-lang/rust/blob/master/src/libstd/io/mod.rs#L512-L517" target="_blank" title="https://github.com/rust-lang/rust/blob/master/src/libstd/io/mod.rs#L512-L517">this</a> and <a href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html#tymethod.read" target="_blank" title="https://doc.rust-lang.org/nightly/std/io/trait.Read.html#tymethod.read">this</a>. Two lines are just missing in the latter, leading to nonsense documentation. WTF?!?</p>



<a name="171367362"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/rustdoc%20%22forgets%22%20two%20lines%20of%20the%20doc%20comment%3F%3F/near/171367362" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> RalfJ <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/rustdoc.20.22forgets.22.20two.20lines.20of.20the.20doc.20comment.3F.3F.html#171367362">(Jul 21 2019 at 10:46)</a>:</h4>
<p>oh, these two lines are <code>//</code> instead of <code>///</code>. Wow.</p>



<a name="171367448"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/rustdoc%20%22forgets%22%20two%20lines%20of%20the%20doc%20comment%3F%3F/near/171367448" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> RalfJ <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/rustdoc.20.22forgets.22.20two.20lines.20of.20the.20doc.20comment.3F.3F.html#171367448">(Jul 21 2019 at 10:48)</a>:</h4>
<p><a href="https://github.com/rust-lang/rust/pull/62845" target="_blank" title="https://github.com/rust-lang/rust/pull/62845">https://github.com/rust-lang/rust/pull/62845</a></p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>